home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
qbbs
/
qscrub_1.zip
/
QSCRUB.DOC
next >
Wrap
Text File
|
1989-04-13
|
9KB
|
331 lines
= = = = = = = = = = = = = =
= =
= QuickScrub Version 1.00 =
= =
= = = = = = = = = = = = = =
The Dirty-Word Detergent and Scrub Brush
For Text Files and Message Bases
Cleans - Disinfects - Deodorizes
Written by Jason A. Cox
Copyright (C)1989 All Rights Reserved
Support Board: ComTron DataCentre
FidoNet 1:170/500
(918)245-5633
QuickScrub Version 1.00 User's Guide - Page 1
INTRODUCTION
QuickScrub will read a user defined list of dirty-words (or
phrases) into memory and search the specified file for any
occurrence. If a match is found, it will replace that phrase
with a user-defined mask character such as an asterisk.
QuickScrub is capable of handling several types of files, as
well as the QuickBBS message base. Because of this
flexibility, and the ability to use wildcards it is not
limited to any one message system or a message system at all.
REGISTRATION
QuickScrub and this document are copyrighted material of
Jason Cox. You are granted a limited license to use, copy
and distribute QuickScrub providing you use the following
Shareware guidelines: No fee is charged for the use or
distribution (not including the media) of QuickScrub or its
support files. QuickScrub must be distributed in its
original, unmodified state (excluding compression/archiving
methods).
If after you have tested QuickScrub on your system and
determine that it is suitable for your application, you are
required to register your copy.
To register your copy send $10 to:
Jason Cox
3102 South Summit Blvd.
Sand Springs, OK 74063
Please include your name, address, phone number, and if
applicable, your FidoNet node number. Site licensing request
and request for licensing exclusion should also be sent to
the above address or FidoNet 1:170/500.
Upon registration you will receive an acknowledgment letter
via FidoNet or your address and a registered update.
QuickScrub comes with no guarantee; however, serious bugs
that are reported will be promptly acted upon.
HOW TO SET IT UP
QuickScrub is fairly easy to use. However, there are a few
things that must be done in order to run QuickScrub. The
first, and most important, is the creation of the Dirty-Word
control file.
QuickScrub Version 1.00 User's Guide - Page 2
THE DIRTY-WORD LIST
The first thing that must be done in order to run QuickScrub
is to create the Dirty-Word list: QSCRUB.LST. This is a
simple text file that contains a list of up to forty words
and phrases. Each phrase-line is limited to forty characters
and must end in a carriage return.
The first line and first character of QSCRUB.LST MUST
contain the mask character that you want QuickScrub to write
over the dirty-words. Any character (with the exception of a
carriage return or an end of file) is considered legal and
may be used as the mask character. On the next line, and the
lines that follow, you enter the phrases to be masked.
An example QSCRUB.LST file:
*
foul
filthy phrase
filthy
3 unwanted words
etc...
This would instruct QuickScrub to replace any of the phrases
(IE: foul) with the asterisk character (IE: ****).
You will notice that I placed "filthy phrase" before
"filthy". Because QuickScrub will search and replace
according to the order of the QSCRUB.LST file, if I had
placed "filthy" before the other, QuickScrub would never see
"filthy phrase", but instead, it would see "****** phrase",
and thus the phrase would only be partially masked.
Similar to the search and replace functions of various
editors, QuickScrub will mask out phrases no matter where
they occur. This could even be inside a word. Because of
this, special care needs to be made in the determination of
the phrases to use. A simple word such as "hello" could
easily become "****o" without the operator knowing what
happened. To prevent such disasters, leading and trailing
spaces can be placed around the phrase (Ie: " foul "). Be
sure that the editor you use doesn't axe off the trailing
space.
NOTE: The number of phrases to search for greatly determines
the amount of time QuickScrub takes to process a file. It is
therefore better to use as few phrases as possible. A four
or five phrase list should be sufficient for most
applications.
Once the QSCRUB.LST control file has been created and placed
in the same directory as QSCRUB.EXE, you are ready to run.
QuickScrub Version 1.00 User's Guide - Page 3
HOW TO USE QUICKSCRUB
To get a brief summary of the command line options, type
QSCRUB ? at the DOS prompt.
QSCRUB <FileName> <!>
The <FileName> can be any valid DOS filename, including
drive, path, and wildcards.
The <!> instructs QuickScrub to use direct-screen writes
for output. This is extremely useful when processing large
files such as the QuickBBS message base. If you are
processing several files (Ie: *.doc), this option is not
advised.
EXAMPLES
To help you understand how to use QuickScrub, I have included
a few examples:
A wildcard example to scrub the mail packets as they comes
in:
QSCRUB C:\BINKLEY\FILES\*.PKT
To make sure you didn't slip up and type a possibly
"excessively annoying" word:
QSCRUB *.MSG
To make sure your finger didn't slip during the documentation
development:
QSCRUB QSCRUB.DOC
The QuickBBS Message base is considered a special case due to
its format. To process (scrub) the QuickBBS message base
type:
QSCRUB MSGTXT.BBS ! (where ! is optional)
QuickScrub could also be used for other message systems:
QSCRUB *.MSG
QSCRUB *.BBS (do not use this for QuickBBS!)
You could even scrub your log files so that your name is
invisible to others:
QSCRUB *.LOG (with "Jason Cox" in QSCRUB.LST)
QuickScrub Version 1.00 User's Guide - Page 4
THE IDEA OF CENSORSHIP
The censoring of outbound or routed messages is forbidden in
FidoNet policy. However, censoring your own message base
and/or files is a great way to keep offensive language from
being viewed by you or your users. QuickScrub provides that
option.
A SPECIAL THANKS TO QUICKSCRUB BETA TESTERS!
Bruce Bodger at 1:170/400
Noel Crow at 1:170/200
Kelly Drown at 1:170/403
Danny Wasson at 1:170/235
"Let's make ShareWare work!"
QUICKSCRUB
Copyright (C) 1989 by Jason A. Cox. ALL RIGHTS RESERVED.
COMMERCIAL USE OF QUICKSCRUB IS NOT PERMITTED WITHOUT WRITTEN
PERMISSION FROM JASON COX. A LIMITED LICENSE IS GRANTED FOR
THE NON-COMMERCIAL TRIAL USE AND SHAREWARE DISTRIBUTION OF
QUICKSCRUB.